Operation Document.Retain (Set as Record and Retain Until)

In component org.nuxeo.retention.operations

Description

Turn the input document into a record and retain it until the until date. Returns back the retained document.

Operation id	Document.Retain
Category	Retention
Label	Set as Record and Retain Until
Requires
Since

Parameters

Name	Description	Type	Required	Default value
flexible	If true and if the document is not already a record, it will be turned into a flexible record, enforced otherwise	boolean	no
until	If empty, the input document will be retained indeterminately	date	no

Signature

Inputs	document, documents
Outputs	document, documents

Implementation Information

Implementation Class	Class: org.nuxeo.retention.operations.RetainDocument
Contributing Component	org.nuxeo.retention.operations

JSON Definition

{
  "id" : "Document.Retain",
  "label" : "Set as Record and Retain Until",
  "category" : "Retention",
  "requires" : null,
  "description" : "Turn the input document into a record and retain it until the until date. Returns back the retained document.",
  "url" : "Document.Retain",
  "signature" : [ "document", "document", "documents", "documents" ],
  "params" : [ {
    "name" : "flexible",
    "description" : "If true and if the document is not already a record, it will be turned into a flexible record, enforced otherwise",
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "until",
    "description" : "If empty, the input document will be retained indeterminately",
    "type" : "date",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}